package com.roi.njzk_big_api.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Profile;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * @ClassName SwaggerConfiguration
 * @Description 范问地址：/doc.html
 * @Author Jason
 * @Version 1.0
 **/
@Configuration
@EnableSwagger2
@Profile("test")
public class SwaggerConfiguration {
    /**
     * 通过 createRestApi函数来构建一个DocketBean
     * 函数名,可以随意命名,喜欢什么命名就什么命名
     */
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                //调用apiInfo方法,创建一个ApiInfo实例,里面是展示在文档页面信息内容
                .apiInfo(apiInfo())
                .select()
                //控制暴露出去的路径下的实例
                //如果某个接口不想暴露,可以使用以下注解
                //@ApiIgnore 这样,该接口就不会暴露在 swagger2 的页面下
                .apis(RequestHandlerSelectors.basePackage("com.roi.business.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    /**
     *  构建 api文档的详细信息函数
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                //页面标题
                .title("怀化热水系统接口文档")
                .description("怀化接口文档Swagger2版")
                //条款地址
//                .termsOfServiceUrl("http://despairyoke.github.io/")
                .contact(new Contact("瑞翼","https://www.baidu.cn", ""))
                .version("1.0")
                //描述
                .description("描述")
                .build();
    }
}
